package org.bwapi.bridge;

/**
 * Interface to handle bot messages
 * 
 * @author Chad Retz
 */
public interface BridgeBot {
	
	/**
	 * Called when this bot (and the game) is started. All initialization
	 * code should be in here, not in the constructor
	 */
	void onStart();
	
	/**
	 * Called when this bot (and the game) is started.
	 */
	void onEnd();
	
	/**
	 * Called every frame of the game
	 */
	void onFrame();
	
	/**
	 * Called when some text is entered and {@link org.bwapi.bridge.model.Flag#USER_INPUT}
	 * is enabled
	 * 
	 * @param string
	 * @return
	 */
	boolean onSendText(String string);
}
